Calendar Class Reference

#include <calendar.h>

Public Member Functions
void	Reset (void)
bool	TickMinute (void)
bool	TickMinute10 (void)
bool	TickHour (void)
void	Tick (void)
long	Date (void)
int	DayInYear (void)
long	OldDays (void)
long	GlobalDate (int a_day, int a_month, int a_year)
int	DayLength (void)
int	DayLength (int a_day_in_year)
int	GetFirstYear (void)
int	GetLastYear (void)
int	GetYear (void)
int	GetYearNumber (void)
int	GetMonth (void)
int	GetMinute (void)
int	GetHour (void)
int	GetDayInMonth (void)
double	GetDaylightProportion (void)
bool	JanFirst (void)
bool	MarchFirst (void)
void	SetFirstYear (int a_year)
void	SetLastYear (int a_year)
bool	ValidDate (int a_day, int a_month)
int	DayInYear (int a_day, int a_month)
	Calendar (void)

Private Attributes
long	m_date
long	m_olddays
int	m_firstyear
int	m_lastyear
int	m_day_in_month
int	m_day_in_year
int	m_month
int	m_year
int	m_simulationyear
int	m_todayslength
double	m_daylightproportion
int	m_minutes
int	m_hours
bool	m_janfirst
bool	m_marchfirst

Static Private Attributes
static int	m_daylength []
	The length of the day between sun up and sun down im minutes (DK - Jutland) More...

Constructor & Destructor Documentation

Calendar()

Calendar::Calendar

(

void

)

{
  Reset();
}

References Reset().

Member Function Documentation

Date()

long Calendar::Date ( void  )

inline

{ return m_date; }

References m_date.

Referenced by Farm::BulbHarvest(), Farm::BurnStrawStubble(), Rabbit_Population_Manager::CheckForRabbitBreedingConditions(), Farm::CheckRotationManagementLoop(), Farm::CutToHay(), VegElement::DoDevelopment(), UnsprayedFieldMargin::DoDevelopment(), Skylark_Population_Manager::DoFirst(), Skylark_Clutch::EndStep(), Skylark_Nestling::EndStep(), Skylark_PreFledgeling::EndStep(), Weather::GetSnow(), Farm::HandleEvents(), OptimisingFarm::HandleEvents(), Farm::Harvest(), OptimisingFarm::Harvest(), Farm::HarvestLong(), Farm::HayBailing(), Farm::HayTurning(), Farm::InitiateManagement(), Skylark_Clutch::OnFarmEvent(), Skylark_Nestling::OnFarmEvent(), Skylark_PreFledgeling::OnFarmEvent(), Skylark_Female::OnFarmEvent(), Skylark_Male::OnFarmEvent(), Skylark_Clutch::OnMumGone(), Farm::RowCultivation(), VegElement::SetGrowthPhase(), Newt_Juvenile::st_Develop(), Newt_Adult::st_Develop(), Newt_Juvenile::st_Disperse(), Newt_Adult::st_Disperse(), Newt_Juvenile::st_Overwinter(), Newt_Adult::st_Overwinter(), Skylark_Female::Step(), Skylark_Male::Step(), Farm::StrawChopping(), Farm::Strigling(), Farm::StriglingSow(), Farm::StubbleHarrowing(), Landscape::SupplyGlobalDate(), and Weather::Tick().

DayInYear() [1/2]

int Calendar::DayInYear	(	int	a_day,
		int	a_month
	)

{
  const int m_monthsum[12] = {
    0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334 };
 
  return m_monthsum[ a_month - 1 ] + a_day - 1;
}

DayInYear() [2/2]

int Calendar::DayInYear ( void  )

inline

{ return m_day_in_year; }

References m_day_in_year.

Referenced by VegElement::CalcGooseForageResources(), Farm::CattleIsOut(), Farm::CattleIsOutLow(), Rabbit_Population_Manager::CheckForRabbitBreedingConditions(), Crop::ChooseNextCrop(), RoadsideVerge::DoDevelopment(), WaterBufferZone::DoDevelopment(), Orchard::DoDevelopment(), OrchardBand::DoDevelopment(), MownGrass::DoDevelopment(), Landscape::DumpMapInfoByArea(), VegElement::ForceGrowthInitialize(), VegElement::ForceGrowthTest(), LE::GetGooseNos(), LE::GetGooseNosToday(), LE::GetGooseNosTodayTimed(), LE::GetGooseSpNosToday(), LE::GetGooseSpNosTodayTimed(), LE::GetQuarryNos(), GlobalDate(), VegElement::PollenNectarPhenologyCalculation(), VegElement::ReduceVeg_Extended(), VegElement::ResetGeese(), Landscape::SupplyDayInYear(), Landscape::Tick(), Weather::Tick(), and LE::Trace().

DayLength() [1/2]

int Calendar::DayLength

(

int

a_day_in_year

)

{
  if ( a_day_in_year<0 || a_day_in_year>364 ) {
    g_msg->Warn( WARN_BUG, "Calendar::DayLength(): Day outside a year!",
      "" );
    exit(1);
  }
  return m_daylength[ a_day_in_year ];
}

References g_msg, m_daylength, MapErrorMsg::Warn(), and WARN_BUG.

DayLength() [2/2]

int Calendar::DayLength ( void  )

inline

{ return m_todayslength; }

References m_todayslength.

Referenced by Landscape::SupplyDaylength().

GetDayInMonth()

int Calendar::GetDayInMonth ( void  )

inline

{ return m_day_in_month; }

References m_day_in_month.

Referenced by Vole_Population_Manager::DoFirst(), Goose_Population_Manager::DoLast(), Landscape::SupplyDayInMonth(), and Landscape::Tick().

GetDaylightProportion()

double Calendar::GetDaylightProportion ( void  )

inline

{ return m_daylightproportion; }

References m_daylightproportion.

Referenced by Landscape::SupplyDaylightProp(), and Landscape::SupplyNightProp().

GetFirstYear()

int Calendar::GetFirstYear ( void  )

inline

{ return m_firstyear; }

References m_firstyear.

GetHour()

int Calendar::GetHour ( void  )

inline

{ return m_hours; }

References m_hours.

Referenced by LargeRoad::GetTrafficLoad(), SmallRoad::GetTrafficLoad(), Hunter_Population_Manager::RecordHuntingSuccess(), and Landscape::SupplyHour().

GetLastYear()

int Calendar::GetLastYear ( void  )

inline

{ return m_lastyear; }

References m_lastyear.

Referenced by Weather::Weather().

GetMinute()

int Calendar::GetMinute ( void  )

inline

{ return m_minutes; }

References m_minutes.

Referenced by Hunter_Population_Manager::RecordHuntingSuccess(), and Landscape::SupplyMinute().

GetMonth()

int Calendar::GetMonth ( void  )

inline

{ return m_month + 1; }

References m_month.

Referenced by Pond::CalcLarvalFood(), RoadsideVerge::DoDevelopment(), PesticideMap::DumpPMap(), LargeRoad::GetTrafficLoad(), SmallRoad::GetTrafficLoad(), and Landscape::SupplyMonth().

GetYear()

int Calendar::GetYear ( void  )

inline

{ return m_year; }

References m_year.

Referenced by PesticideMap::DumpPMap(), Landscape::SupplyYear(), and Landscape::VegDump().

GetYearNumber()

int Calendar::GetYearNumber ( void  )

inline

{ return m_simulationyear; }

References m_simulationyear.

Referenced by OptimisingFarm::ActualProfit(), Rabbit_Population_Manager::CheckForRabbitBreedingConditions(), OptimisingFarm::ChooseDecisionMode(), Crop::ChooseNextCrop(), FarmManager::PrintFinalResults(), Landscape::SupplyYearNumber(), Landscape::Tick(), and LE::Trace().

GlobalDate()

long Calendar::GlobalDate	(	int	a_day,
		int	a_month,
		int	a_year
	)

{
  return m_olddays + DayInYear( a_day, a_month) + a_year*365;
}

References DayInYear(), and m_olddays.

JanFirst()

bool Calendar::JanFirst ( void  )

inline

{ return m_janfirst; }

References m_janfirst.

Referenced by RoadsideVerge::DoDevelopment(), WaterBufferZone::DoDevelopment(), Orchard::DoDevelopment(), MownGrass::DoDevelopment(), and Landscape::Tick().

MarchFirst()

bool Calendar::MarchFirst ( void  )

inline

{ return m_marchfirst; }

References m_marchfirst.

Referenced by Landscape::Tick().

OldDays()

long Calendar::OldDays ( void  )

inline

{ return m_olddays; }

References m_olddays.

Referenced by Landscape::DumpMapInfoByArea(), and Newt_Population_Manager::SetFreeLivingMortChance().

Reset()

void Calendar::Reset

(

void

)

{
  m_date         = 0;
  m_olddays      = 0;
  m_day_in_month = 1;
  m_minutes      = 0;
  m_hours        = 0;
  m_day_in_year  = 0; // [0..364]
  m_month        = 0; // [0..11]
  m_year         = m_firstyear;
  m_simulationyear = 0;
  m_janfirst     = true;
  m_marchfirst   = false;
}

References m_date, m_day_in_month, m_day_in_year, m_firstyear, m_hours, m_janfirst, m_marchfirst, m_minutes, m_month, m_olddays, m_simulationyear, and m_year.

Referenced by Calendar(), Landscape::Landscape(), and Weather::Weather().

SetFirstYear()

void Calendar::SetFirstYear ( int  a_year )

inline

{ m_firstyear = a_year; }

References m_firstyear.

Referenced by Weather::Weather().

SetLastYear()

void Calendar::SetLastYear ( int  a_year )

inline

{ m_lastyear = a_year; }

References m_lastyear.

Referenced by Weather::Weather().

Tick()

void Calendar::Tick

(

void

)

{
  const int m_monthlength[12] = {
    31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 };
  const int m_maxmonth = 11;
 
  m_minutes    = 0;
  m_hours      = 0;
  m_date++;
  m_day_in_year++;
  m_day_in_month++;
  m_janfirst   = false;
  m_marchfirst = false;
 
  if ( m_day_in_month > m_monthlength[ m_month ])
  {
    m_day_in_month = 1;
    m_month++;
    if ( m_month == 2 )
      // March 1st.
      m_marchfirst = true;
  }
 
  if ( m_month > m_maxmonth )
  {
    m_month = 0;
    m_year++;
    m_simulationyear++;
    m_olddays += 365;
    m_janfirst = true;
    m_day_in_year = 0;
  }
  m_todayslength = m_daylength[ m_day_in_year ];
  m_daylightproportion = m_daylength[m_day_in_year] / 1440.0;
}

References m_date, m_day_in_month, m_day_in_year, m_daylength, m_daylightproportion, m_hours, m_janfirst, m_marchfirst, m_minutes, m_month, m_olddays, m_simulationyear, m_todayslength, and m_year.

Referenced by Landscape::Tick().

TickHour()

bool Calendar::TickHour

(

void

)

{
    bool dotick = false;
 
  if ( ++m_hours > 23 ) {
    m_minutes = 0;
    m_hours   = 0;
    dotick = true;
  }
  return dotick;
}

References m_hours, and m_minutes.

Referenced by RunTheSim().

TickMinute()

bool Calendar::TickMinute

(

void

)

{
    bool dotick = false;
 
    if (m_minutes++ > 59) {
        m_minutes = 0;
        dotick = true;
    }
    return dotick;
}

References m_minutes.

TickMinute10()

bool Calendar::TickMinute10

(

void

)

{
    bool dotick = false;
    m_minutes += 10;
    if (m_minutes > 59) {
        m_minutes = 0;
        dotick = true;
    }
    return dotick;
}

References m_minutes.

Referenced by RunTheSim().

ValidDate()

bool Calendar::ValidDate	(	int	a_day,
		int	a_month
	)

{
  const int m_monthlength[12] = {
    31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 };
 
  if ( a_month < 1  ||
       a_month > 12 ||
       a_day < 1    ||
       a_day > m_monthlength[ a_month - 1 ] ) {
    return false;
  } else {
    return true;
  }
}

Member Data Documentation

m_date

long Calendar::m_date

private

Referenced by Date(), Reset(), and Tick().

m_day_in_month

int Calendar::m_day_in_month

private

Referenced by GetDayInMonth(), Reset(), and Tick().

m_day_in_year

int Calendar::m_day_in_year

private

Referenced by DayInYear(), Reset(), and Tick().

m_daylength

int Calendar::m_daylength

staticprivate

The length of the day between sun up and sun down im minutes (DK - Jutland)

Referenced by DayLength(), and Tick().

m_daylightproportion

double Calendar::m_daylightproportion

private

Referenced by GetDaylightProportion(), and Tick().

m_firstyear

int Calendar::m_firstyear

private

Referenced by GetFirstYear(), Reset(), and SetFirstYear().

m_hours

int Calendar::m_hours

private

Referenced by GetHour(), Reset(), Tick(), and TickHour().

m_janfirst

bool Calendar::m_janfirst

private

Referenced by JanFirst(), Reset(), and Tick().

m_lastyear

int Calendar::m_lastyear

private

Referenced by GetLastYear(), and SetLastYear().

m_marchfirst

bool Calendar::m_marchfirst

private

Referenced by MarchFirst(), Reset(), and Tick().

m_minutes

int Calendar::m_minutes

private

Referenced by GetMinute(), Reset(), Tick(), TickHour(), TickMinute(), and TickMinute10().

m_month

int Calendar::m_month

private

Referenced by GetMonth(), Reset(), and Tick().

m_olddays

long Calendar::m_olddays

private

Referenced by GlobalDate(), OldDays(), Reset(), and Tick().

m_simulationyear

int Calendar::m_simulationyear

private

Referenced by GetYearNumber(), Reset(), and Tick().

m_todayslength

int Calendar::m_todayslength

private

Referenced by DayLength(), and Tick().

m_year

int Calendar::m_year

private

Referenced by GetYear(), Reset(), and Tick().

---

The documentation for this class was generated from the following files:

• /builds/a1mass/almass_stable_oddox/Landscape/calendar.h
• /builds/a1mass/almass_stable_oddox/Landscape/calendar.cpp
• /builds/a1mass/almass_stable_oddox/Landscape/daylength.h